docs(durable-functions): mark v3 entity-lock API as won't-restore (#317)#331
Closed
YunchuWang wants to merge 1 commit into
Closed
docs(durable-functions): mark v3 entity-lock API as won't-restore (#317)#331YunchuWang wants to merge 1 commit into
YunchuWang wants to merge 1 commit into
Conversation
The core `context.entities.*` lock API is the permanent replacement. Flip the README migration note from "restoring ... is tracked in #317" to a final "will not be restored" decision. Rationale (recorded on #317): the Python SDK ships only the core-native lock API and its classic Functions SDK never exposed df.lock/is_locked, so there is no compat surface to mirror; JS is the outlier because v3 uniquely exposed it, and reviving the v3 shape would require an engine-level Task.map (determinism-sensitive). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: d86f5f69-4e1a-4c1d-b017-5e290c85cc05
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the durable-functions v4 migration guidance to close out #317 by documenting that the v3 entity-lock API (context.df.lock / isLocked and related types) will not be restored, and that users should adopt the core-native context.entities.* locking APIs going forward.
Changes:
- Replaces the “tracked in #317” note with a final “will not be restored” decision.
- Adds a short cross-SDK rationale and keeps the supported core API pointers (
lockEntities,isInCriticalSection).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the resolution of #317 as won''t-do: keep the core-native entity-lock migration and do not restore the v3
df.lock/isLockedsurface.This is a docs-only change. It flips the one-sentence note in the package README''s "Migrating from durable-functions v3" section (the "Entity locking / critical sections moved to the core context." bullet) from "restoring the v3 surface is tracked in #317" to a final "will not be restored" decision, and points readers to the supported core
context.entities.*lock API.Rationale (recorded on #317): the Python SDK ships only the core-native lock API and its classic Functions SDK never exposed
df.lock/is_locked, so there is no cross-SDK compat surface to mirror; JS was the outlier because v3 uniquely exposed it, and reviving the v3 shape would require an engine-levelTask.map(determinism-sensitive).No code, CHANGELOG, or test changes - README.md only. See #317 for the full rationale (issue is being closed manually).